Document the DAYamlChecker --fix mode - #631
Merged
Merged
Conversation
`--fix` rewrites the four findings that have only one sensible answer -- a missing question id, a duplicate block id, a yes/no shorthand, and the first unlabeled field on a multi-field screen -- and then checks the result. The new section covers what each fix writes, including how generated ids are normalized and why a question carrying Mako line directives moves to the `label:`/`field:` long form. It also covers what the fixer declines to do: every edit is validated before it is written, and a file whose candidate would introduce a new finding of any rule is left alone rather than trading one finding for another. Two things authors are most likely to be surprised by are called out directly: expanding a yes/no shorthand changes what the applicant sees, and `--suppress ALL` disables fixing along with reporting. The worked example was run through the fixer and its before/after and console output are reproduced verbatim. Co-Authored-By: Claude Opus 5 <[email protected]> Claude-Session: https://claude.ai/code/session_01LNbgp4BzZY9JmUHjWjnWT1
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
dayamlchecker --fixlanded in DAYamlChecker#85. This documents it.What is covered
A new Fixing findings automatically section on the DAYamlChecker page, placed after the six "what it checks" sections so the codes are already familiar, plus a short pointer from Running checks locally and a
--fixrow in the command line reference.The section covers the four rules
--fixwrites (EG414,EG104,EA510,EA502), a worked before/after example, and then two things that matter more than the mechanics:label:/field:long form instead of being folded into a one-line label.WA515).Two things authors are most likely to be surprised by are called out directly:
--suppress ALLdisables fixing along with reporting.Verification
The worked example was extracted back out of the finished page and re-run through the fixer. Its before, its after, and the console output are reproduced verbatim.
npm run buildis clean and neither page appears in the site's broken-anchor warnings.🤖 Generated with Claude Code
https://claude.ai/code/session_01LNbgp4BzZY9JmUHjWjnWT1